package com.ld.poetry.entity;

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.TableField;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;
import lombok.Data;
import lombok.EqualsAndHashCode;

import java.io.Serializable;
import java.util.List;

/**
 * 分类信息实体类
 * 
 * 功能说明：
 * 1. 用于管理文章的分类信息
 * 2. 支持导航栏分类和普通分类两种类型
 * 3. 支持分类优先级排序
 * 
 * 表结构说明：
 * - 表名：sort
 * - 主键：id（自增）
 * 
 * 使用场景：
 * 1. 文章分类管理
 * 2. 导航栏分类展示
 * 3. 文章归类
 * 
 * @author sara
 * @since 2021-09-14
 */
@Data
@EqualsAndHashCode(callSuper = false)
@TableName("sort")
public class Sort implements Serializable {

    private static final long serialVersionUID = 1L;

    /**
     * 分类ID
     * 说明：
     * - 主键，自增
     * - 用于唯一标识一个分类
     */
    @TableId(value = "id", type = IdType.AUTO)
    private Integer id;

    /**
     * 分类名称
     * 说明：
     * - 分类的显示名称
     * - 必填字段
     * - 用于前端展示
     */
    @TableField("sort_name")
    private String sortName;

    /**
     * 分类描述
     * 说明：
     * - 分类的详细描述信息
     * - 可选字段
     * - 用于说明分类的用途或特点
     */
    @TableField("sort_description")
    private String sortDescription;

    /**
     * 分类类型
     * 说明：
     * - 0: 导航栏分类
     * - 1: 普通分类
     * - 用于区分不同类型的分类
     * - 影响分类的展示位置和方式
     */
    @TableField("sort_type")
    private Integer sortType;

    /**
     * 分类优先级
     * 说明：
     * - 数字小的优先级高，排在前面
     * - 用于控制分类的显示顺序
     * - 相同优先级的分类按创建时间排序
     */
    @TableField("priority")
    private Integer priority;

    /**
     * 分类下的文章数量
     * 说明：
     * - 非数据库字段
     * - 用于统计该分类下的文章数量
     * - 在查询时动态计算
     */
    @TableField(exist = false)
    private Integer countOfSort;

    /**
     * 分类下的标签列表
     * 说明：
     * - 非数据库字段
     * - 用于存储该分类下的所有标签
     * - 在查询时通过关联查询获取
     */
    @TableField(exist = false)
    private List<Label> labels;
}
